Adding Enabling hermetic builds #23
Conversation
|
@ralphbean @arewm Please confirm this AppStudio how-to can be published for Konflux as is. |
|
@gtrivedi88 or @Chr1st1anSears The Troubleshooting section of this guide was added via A link to the original AppStudio doc: https://github.com/redhat-appstudio/docs.appstudio.io/blob/main/docs/modules/ROOT/pages/how-to-guides/proc_hermetic-builds.adoc?plain=1 |
I think the way you did it here makes great sense. Not sure why Jocelyn added the Troubleshooting stuff that way. She was probably trying to do modular docs. But again I think the way you did stuff here looks great 👍 |
|
🚀 Preview is available at |
| * Hermetic builds disable network access, so a build with dependencies outside of its Git repository--including supported languages--might fail. To prevent this, or to pull in dependencies from a package manager for one of the xref:how-tos/configuring/prefetching-dependencies.adoc#supported-languages[supported languages], follow the instructions in link:https://konflux-ci.dev/docs/how-tos/configuring/prefetching-dependencies/[Prefetching the package manager dependencies for the hermetic build]. | ||
| + | ||
| Similarly, with a link:https://github.com/redhat-appstudio/build-definitions/blob/main/task/buildah/0.1/buildah.yaml[Buildah] task for a non-Java application, when you set the `*hermetic*` parameter to `true`, you’re isolating the build from the network, which restricts it to building only from dependencies listed in your Git repository. |
| [IMPORTANT] | ||
| ==== | ||
| * Hermetic builds disable network access, so a build with dependencies outside of its Git repository--including supported languages--might fail. To prevent this, or to pull in dependencies from a package manager for one of the xref:how-tos/configuring/prefetching-dependencies.adoc#supported-languages[supported languages], follow the instructions in link:https://konflux-ci.dev/docs/how-tos/configuring/prefetching-dependencies/[Prefetching the package manager dependencies for the hermetic build]. |
There was a problem hiding this comment.
Nit: Can you add a TODO (even if an href comment that isn't rendered visibly) for the supported languages section or a reminder on the Jira so that we have some reminder of the work needed ?
| If your build fails, be sure to look at your logs: | ||
|
|
||
| In {ProductName}, from the *Applications* view, select the application build you want to troubleshoot, then from the resulting *Overview* page, select the *Activity* tab. From there, under *Activity By*, select *Pipeline runs*. From the *Name* column, select the build whose logs you want to check, then from the resulting *Pipeline run details* view, do one of the following: | ||
|
|
||
| * Select the *Logs* tab. | ||
| * Alternatively, you can click *build-container*. When the right panel opens, select the *Logs* tab to see a partial view of the log for that build. |
There was a problem hiding this comment.
Nit: This feels like more of a generic troubleshooting help. What would be the best way to organize the troubleshooting? A single place for the entire page? Distributed across pages? "General" guides for each topic section or subsection (i.e. how-to or configuring)?
|
@arewm Thank you for the review and all the nits. I'll make sure all the links are live and working at the time of the release, yes. Re: the troubleshooting part, we'll discuss it in the team and decide what's the best way to proceed. I believe the writer before me meant to single-source such content, we'll figure it out. Thanks. |
xref "supported languages" won't work till we publish relevant content with a page element #supported-languages
Buildah link sends users to an AppStudio GH repo https://github.com/redhat-appstudio/build-definitions/blob/main/task/buildah/0.1/buildah.yaml Is there a Konflux counterpart? Is it needed?